ly.img:plugin-background-removal/ly.img.editor.plugin.backgroundRemoval

Package-level declarations

Types

BackgroundRemovalConfig

interface BackgroundRemovalConfig

Configuration for the background removal plugin.

BackgroundRemovalMask

data class BackgroundRemovalMask(val buffer: ByteBuffer, val width: Int, val height: Int)

Segmentation mask returned by a background removal backend.

BackgroundRemovalPlugin

open class BackgroundRemovalPlugin : EditorConfigurationBuilder

Plugin for background removal. This plugin adds a button to the Dock that removes the background of the current page's image. Add InspectorBar.Button.rememberBackgroundRemoval with inspectorBarModifier to remove the background of the selected image or page. The results are PNG files in the app's cache directory, which Android can clear. To keep them, upload the file:// URIs that engine.editor.findAllMediaURIs() returns, and point the scene to the uploads with engine.editor.relocateResource.

Functions

rememberBackgroundRemoval

@Composable

fun Dock.Button.rememberBackgroundRemoval(config: BackgroundRemovalConfig, builder: Dock.ButtonBuilder.() -> Unit = {}): Button<Dock.ItemScope>

A composable helper function that creates and remembers a Dock.Button that removes the background of the image of the current page. The button is only visible when the page has an image fill that is not SVG, and its scope allows a fill change.

@Composable

fun InspectorBar.Button.rememberBackgroundRemoval(config: BackgroundRemovalConfig, builder: InspectorBar.ButtonBuilder.() -> Unit = {}): Button<InspectorBar.ItemScope>

A composable helper function that creates and remembers an InspectorBar.Button that removes the background of the selected image or page. The button is hidden for stickers, and only visible when the block has an image fill that is not SVG, and its scope allows a fill change.